<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>Box2 - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
	<h1 translate="no">Box2</h1>
		<section>
			<header>
				<div class="class-description"><p>Represents an axis-aligned bounding box (AABB) in 2D space.</p></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="Box2" translate="no">new <a href="#Box2">Box2</a><span class="signature">( min : <span class="param-type"><a href="Vector2.html">Vector2</a></span>, max : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new bounding box.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>min</strong>
									</td>
									<td class="description last">
										<p>A vector representing the lower boundary of the box.</p>
										<p>Default is <code>(Infinity,Infinity)</code>.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>max</strong>
									</td>
									<td class="description last">
										<p>A vector representing the upper boundary of the box.</p>
										<p>Default is <code>(-Infinity,-Infinity)</code>.</p>
									</td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="isBox2" translate="no">.<a href="#isBox2">isBox2</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
					<div class="description">
						<p>This flag can be used for type testing.</p>
						<p>Default is <code>true</code>.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="max" translate="no">.<a href="#max">max</a><span class="type-signature"> : <a href="Vector2.html">Vector2</a></span> </h3>
					<div class="description">
						<p>The upper boundary of the box.</p>
					</div>
				</div>
				<div class="member">
					<h3 class="name" id="min" translate="no">.<a href="#min">min</a><span class="type-signature"> : <a href="Vector2.html">Vector2</a></span> </h3>
					<div class="description">
						<p>The lower boundary of the box.</p>
					</div>
				</div>
				<h2 class="subsection-title">Methods</h2>
					<h3 class="name name-method" id="clampPoint" translate="no">.<a href="#clampPoint">clampPoint</a><span class="signature">( point : <span class="param-type"><a href="Vector2.html">Vector2</a></span>, target : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Vector2.html">Vector2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Clamps the given point within the bounds of this box.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>point</strong>
									</td>
									<td class="description last">
										<p>The point to clamp.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>target</strong>
									</td>
									<td class="description last">
										<p>The target vector that is used to store the method's result.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The clamped point.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="clone" translate="no">.<a href="#clone">clone</a><span class="signature">()</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns a new box with copied values from this instance.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A clone of this instance.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="containsBox" translate="no">.<a href="#containsBox">containsBox</a><span class="signature">( box : <span class="param-type"><a href="Box2.html">Box2</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if this bounding box includes the entirety of the given bounding box.
If this box and the given one are identical, this function also returns <code>true</code>.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>box</strong>
									</td>
									<td class="description last">
										<p>The bounding box to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the bounding box contains the given bounding box or not.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="containsPoint" translate="no">.<a href="#containsPoint">containsPoint</a><span class="signature">( point : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the given point lies within or on the boundaries of this box.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>point</strong>
									</td>
									<td class="description last">
										<p>The point to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the bounding box contains the given point or not.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="copy" translate="no">.<a href="#copy">copy</a><span class="signature">( box : <span class="param-type"><a href="Box2.html">Box2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Copies the values of the given box to this instance.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>box</strong>
									</td>
									<td class="description last">
										<p>The box to copy.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="distanceToPoint" translate="no">.<a href="#distanceToPoint">distanceToPoint</a><span class="signature">( point : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : number</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the euclidean distance from any edge of this box to the specified point. If
the given point lies inside of this box, the distance will be <code>0</code>.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>point</strong>
									</td>
									<td class="description last">
										<p>The point to compute the distance to.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The euclidean distance.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="equals" translate="no">.<a href="#equals">equals</a><span class="signature">( box : <span class="param-type"><a href="Box2.html">Box2</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if this bounding box is equal with the given one.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>box</strong>
									</td>
									<td class="description last">
										<p>The box to test for equality.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether this bounding box is equal with the given one.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="expandByPoint" translate="no">.<a href="#expandByPoint">expandByPoint</a><span class="signature">( point : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Expands the boundaries of this box to include the given point.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>point</strong>
									</td>
									<td class="description last">
										<p>The point that should be included by the bounding box.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="expandByScalar" translate="no">.<a href="#expandByScalar">expandByScalar</a><span class="signature">( scalar : <span class="param-type">number</span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Expands each dimension of the box by the given scalar. If negative, the
dimensions of the box will be contracted.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>scalar</strong>
									</td>
									<td class="description last">
										<p>The scalar value that should expand the bounding box.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="expandByVector" translate="no">.<a href="#expandByVector">expandByVector</a><span class="signature">( vector : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Expands this box equilaterally by the given vector. The width of this
box will be expanded by the x component of the vector in both
directions. The height of this box will be expanded by the y component of
the vector in both directions.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>vector</strong>
									</td>
									<td class="description last">
										<p>The vector that should expand the bounding box.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="getCenter" translate="no">.<a href="#getCenter">getCenter</a><span class="signature">( target : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Vector2.html">Vector2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the center point of this box.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>target</strong>
									</td>
									<td class="description last">
										<p>The target vector that is used to store the method's result.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The center point.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="getParameter" translate="no">.<a href="#getParameter">getParameter</a><span class="signature">( point : <span class="param-type"><a href="Vector2.html">Vector2</a></span>, target : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Vector2.html">Vector2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns a point as a proportion of this box's width and height.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>point</strong>
									</td>
									<td class="description last">
										<p>A point in 2D space.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>target</strong>
									</td>
									<td class="description last">
										<p>The target vector that is used to store the method's result.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A point as a proportion of this box's width and height.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="getSize" translate="no">.<a href="#getSize">getSize</a><span class="signature">( target : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Vector2.html">Vector2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns the dimensions of this box.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>target</strong>
									</td>
									<td class="description last">
										<p>The target vector that is used to store the method's result.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> The size.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="intersect" translate="no">.<a href="#intersect">intersect</a><span class="signature">( box : <span class="param-type"><a href="Box2.html">Box2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Computes the intersection of this bounding box and the given one, setting the upper
bound of this box to the lesser of the two boxes' upper bounds and the
lower bound of this box to the greater of the two boxes' lower bounds. If
there's no overlap, makes this box empty.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>box</strong>
									</td>
									<td class="description last">
										<p>The bounding box to intersect with.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="intersectsBox" translate="no">.<a href="#intersectsBox">intersectsBox</a><span class="signature">( box : <span class="param-type"><a href="Box2.html">Box2</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns <code>true</code> if the given bounding box intersects with this bounding box.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>box</strong>
									</td>
									<td class="description last">
										<p>The bounding box to test.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether the given bounding box intersects with this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="isEmpty" translate="no">.<a href="#isEmpty">isEmpty</a><span class="signature">()</span><span class="type-signature"> : boolean</span> </h3>
					<div class="method">
						<div class="description">
							<p>Returns true if this box includes zero points within its bounds.
Note that a box with equal lower and upper bounds still includes one
point, the one both bounds share.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> Whether this box is empty or not.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="makeEmpty" translate="no">.<a href="#makeEmpty">makeEmpty</a><span class="signature">()</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Makes this box empty which means in encloses a zero space in 2D.</p>
						</div>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="set" translate="no">.<a href="#set">set</a><span class="signature">( min : <span class="param-type"><a href="Vector2.html">Vector2</a></span>, max : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the lower and upper boundaries of this box.
Please note that this method only copies the values from the given objects.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>min</strong>
									</td>
									<td class="description last">
										<p>The lower boundary of the box.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>max</strong>
									</td>
									<td class="description last">
										<p>The upper boundary of the box.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setFromCenterAndSize" translate="no">.<a href="#setFromCenterAndSize">setFromCenterAndSize</a><span class="signature">( center : <span class="param-type"><a href="Vector2.html">Vector2</a></span>, size : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Centers this box on the given center vector and sets this box's width, height and
depth to the given size values.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>center</strong>
									</td>
									<td class="description last">
										<p>The center of the box.</p>
									</td>
								</tr>
								<tr>
									<td class="name">
										<strong>size</strong>
									</td>
									<td class="description last">
										<p>The x and y dimensions of the box.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="setFromPoints" translate="no">.<a href="#setFromPoints">setFromPoints</a><span class="signature">( points : <span class="param-type">Array.&lt;<a href="Vector2.html">Vector2</a>></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Sets the upper and lower bounds of this box so it encloses the position data
in the given array.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>points</strong>
									</td>
									<td class="description last">
										<p>An array holding 2D position data as instances of <a href="Vector2.html">Vector2</a>.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="translate" translate="no">.<a href="#translate">translate</a><span class="signature">( offset : <span class="param-type"><a href="Vector2.html">Vector2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Adds the given offset to both the upper and lower bounds of this bounding box,
effectively moving it in 2D space.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>offset</strong>
									</td>
									<td class="description last">
										<p>The offset that should be used to translate the bounding box.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
					<h3 class="name name-method" id="union" translate="no">.<a href="#union">union</a><span class="signature">( box : <span class="param-type"><a href="Box2.html">Box2</a></span> )</span><span class="type-signature"> : <a href="Box2.html">Box2</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Computes the union of this box and another and the given one, setting the upper
bound of this box to the greater of the two boxes' upper bounds and the
lower bound of this box to the lesser of the two boxes' lower bounds.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name">
										<strong>box</strong>
									</td>
									<td class="description last">
										<p>The bounding box that will be unioned with this instance.</p>
									</td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A reference to this bounding box.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/math/Box2.js" translate="no" target="_blank" rel="noopener">src/math/Box2.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>